导航菜单
首页 >  jQuery 参考手册  > jQuery API 中文文档

jQuery API 中文文档

jQuery API 中文文档

jQuery 是一个高效、精简并且功能丰富的 JavaScript 工具库。它提供的 API 易于使用且兼容众多浏览器,这让诸如 HTML 文档遍历和操作、事件处理、动画和 Ajax 操作更加简单。如果你是一个 jQuery 新手,我们建议你先到jQuery 学习中心历练历练。

如果你是在升级新版本的 jQuery ,务必阅读我们博客上列出的版本发布说明。如果你以前使用的是 1.9 版本之前的 jQuery ,建议你再看一看 1.9 版本升级指南。

注意,这份 API 中文文档是关于 jQuery 的,其他兄弟项目的 API 文档地址如下:

jQuery UI API 文档jQuery Mobile API 文档QUnit API 文档Traversing > Miscellaneous Traversing.add()添加元素到匹配的元素集合。Traversing > Miscellaneous Traversing.addBack()添加堆栈中元素集合到当前集合,一个选择性的过滤选择器。Attributes | Manipulation > Class Attribute | CSS.addClass()为每个匹配的元素添加指定的样式类名Manipulation > DOM Insertion, Outside.after()在匹配元素集合中的每个元素后面插入参数所指定的内容,作为其兄弟节点。Ajax > Global Ajax Event Handlers | Deprecated > Deprecated 3.5.ajaxComplete()Register a handler to be called when Ajax requests complete. This is an AjaxEvent.Ajax > Global Ajax Event HandlersajaxComplete event当Ajax请求完成后注册一个回调函数。这是一个 AjaxEvent。Ajax > Global Ajax Event Handlers | Deprecated > Deprecated 3.5.ajaxError()Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event.Ajax > Global Ajax Event HandlersajaxError eventAjax请求出错时注册一个回调处理函数,这是一个 Ajax Event。Ajax > Global Ajax Event Handlers | Deprecated > Deprecated 3.5.ajaxSend()Attach a function to be executed before an Ajax request is sent. This is an Ajax Event.Ajax > Global Ajax Event HandlersajaxSend event在Ajax请求发送之前绑定一个要执行的函数,这是一个 Ajax Event.Ajax > Global Ajax Event Handlers | Deprecated > Deprecated 3.5.ajaxStart()Register a handler to be called when the first Ajax request begins. This is an Ajax Event.Ajax > Global Ajax Event HandlersajaxStart event在AJAX 请求刚开始时执行一个处理函数。 这是一个 Ajax Event.Ajax > Global Ajax Event Handlers | Deprecated > Deprecated 3.5.ajaxStop()Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.Ajax > Global Ajax Event HandlersajaxStop event在AJAX 请求完成时执行一个处理函数。 这是一个 Ajax Event。Ajax > Global Ajax Event Handlers | Deprecated > Deprecated 3.5.ajaxSuccess()Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event.Ajax > Global Ajax Event HandlersajaxSuccess event绑定一个函数当 Ajax 请求成功完成时执行。 这是一个Ajax Event.Selectors > BasicAll Selector ("*")选择所有元素.Traversing > Miscellaneous Traversing | Deprecated > Deprecated 1.8 | Removed.andSelf()添加先前的堆栈元素集合到当前组合。Effects > Custom.animate()根据一组 CSS 属性,执行自定义动画。Selectors > Basic Filter | Selectors > jQuery Extensions:animated Selector选择所有正在执行动画效果的元素.Manipulation > DOM Insertion, Inside.append()在每个匹配元素里面的末尾处插入参数内容。Manipulation > DOM Insertion, Inside.appendTo()将匹配的元素插入到目标元素的最后面(译者注:内部插入)。Attributes | Manipulation > General Attributes.attr()获取匹配的元素集合中的第一个元素的属性的值。设置每一个匹配元素的一个或多个属性。Selectors > AttributeAttribute Contains Prefix Selector [name|="value"]选择指定属性值等于给定字符串或以该字符串为前缀(该字符串后跟一个连字符“-” )的元素。Selectors > AttributeAttribute Contains Selector [name*="value"]选择指定属性具有包含一个给定的子字符串的元素。(选择给定的属性是以包含某些值的元素)Selectors > AttributeAttribute Contains Word Selector [name~="value"]选择指定属性用空格分隔的值中包含一个给定值的元素。Selectors > AttributeAttribute Ends With Selector [name$="value"]选择指定属性是以给定值结尾的元素。这个比较是区分大小写的。Selectors > AttributeAttribute Equals Selector [name="value"]选择指定属性是给定值的元素。Selectors > Attribute | Selectors > jQuery ExtensionsAttribute Not Equal Selector [name!="value"]选择不存在指定属性,或者指定的属性值不等于给定值的元素。Selectors > AttributeAttribute Starts With Selector [name^="value"]选择指定属性是以给定字符串开始的元素Manipulation > DOM Insertion, Outside.before()根据参数设定,在匹配元素的前面插入内容(译者注:外部插入)Events > Event Handler Attachment | Deprecated > Deprecated 3.0.bind()为一个元素绑定一个事件处理程序。Events > Form Events | Forms | Deprecated > Deprecated 3.3.blur()Bind an event handler to the "blur" event, or trigger that event on an element.Events > Form Events | Formsblur event为 "blur" 事件绑定一个处理函数,或者触发元素上的 "blur" 事件(注:此事件不支持冒泡)。Selectors > Form | Selectors > jQuery Extensions:button Selector选择所有按钮元素和类型为按钮的元素。Callbacks Objectcallbacks.add()回调列表中添加一个回调或回调的集合。Callbacks Objectcallbacks.disable()禁用回调列表中的回调Callbacks Objectcallbacks.disabled()确定回调列表是否已被禁用。Callbacks Objectcallbacks.empty()从列表中删除所有的回调.Callbacks Objectcallbacks.fire()传入指定的参数调用所有的回调Callbacks Objectcallbacks.fireWith()访问给定的上下文和参数列表中的所有回调。Callbacks Objectcallbacks.fired()确定回调是否至少已经调用一次。Callbacks Objectcallbacks.has()确定列表中是否提供一个回调Callbacks Objectcallbacks.lock()锁定回调列表的当前状态。Callbacks Objectcallbacks.locked()确定回调列表是否已被锁定。Callbacks Objectcallbacks.remove()从回调列表中的删除一个回调或回调集合。Events > Form Events | Deprecated > Deprecated 3.3.change()Bind an event handler to the "change" event, or trigger that event on an element.Events > Form Events | Formschange event为JavaScript 的 "change" 事件绑定一个处理函数,或者触发元素上的 "change" 事件。Selectors > Form | Selectors > jQuery Extensions:checkbox Selector选择所有类型为复选框的元素。Selectors > Form:checked Selector匹配所有勾选的元素。Selectors > HierarchyChild Selector ("parent > child")选择所有指定“parent”元素中指定的"child"的直接子元素。Traversing > Tree Traversal.children()获得匹配元素集合中每个元素的子元素,选择器选择性筛选。Selectors > BasicClass Selector (".class")选择给定样式类名的所有元素。Effects > Custom | Data | Utilities.clearQueue()从列队中移除所有未执行的项。Events > Mouse Events | Deprecated > Deprecated 3.3.click()Bind an event handler to the "click" event, or trigger that event on an element.Events > Mouse Eventsclick event为 JavaScript 的"click" 事件绑定一个处理器,或者触发元素上的 "click" 事件。Manipulation > Copying.clone()创建一个匹配的元素集合的深度拷贝副本。Traversing > Tree Traversal.closest()从元素本身开始,在DOM 树上逐级向上级元素匹配,并返回最先匹配的祖先元素。以数组的形式返回与选择器相匹配的所有元素,从当前元素开始,在 DOM 树中向上遍历。Selectors > Content Filter | Selectors > jQuery Extensions:contains() Selector选择所有包含指定文本的元素。Traversing > Miscellaneous Traversing.contents()获得匹配元素集合中每个元素的子元素,包括文字和注释节点。Internals | Properties > Properties of jQuery Object Instances | Deprecated > Deprecated 1.10 | Removed.context原始的DOM节点的内容传给jQuery();如果没有东西被传递,那么上下文将可能是该文档(document)。Events > Mouse Events | Deprecated > Deprecated 3.3.contextmenu()Bind an event handler to the "contextmenu" event, or trigger that event on an element.Events > Mouse Eventscontextmenu eventBind an event handler to the "contextmenu" event, or trigger that event on an element.CSS | Manipulation > Style Properties.css()获取匹配元素集合中的第一个元素的样式属性的值设置每个匹配元素的一个或多个CSS属性。Data | Miscellaneous > Data Storage.data()在匹配元素上存储任意相关数据. 返回匹配的元素集合中的第一个元素的给定名称的数据存储的值。 通过.data(name, value)或HTML5 data-* 属性设置Events > Mouse Events | Deprecated > Deprecated 3.3.dblclick()Bind an event handler to the "dblclick" event, or trigger that event on an element.Events > Mouse Eventsdblclick event为JavaScript 的 "dblclick" 事件绑定一个处理函数,或者触发元素上的 "dblclick" 事件。Deferred Objectdeferred.always()当Deferred(延迟)对象解决或拒绝时,调用添加处理程序。Deferred Objectdeferred.catch()Add handlers to be called when the Deferred object is rejected. Deferred Objectdeferred.done()当Deferred(延迟)对象解决时,调用添加处理程序。Deferred Objectdeferred.fail()当Deferred(延迟)对象拒绝时,调用添加的处理程序。Deferred Object | Deprecated > Deprecated 1.7 | Removeddeferred.isRejected()确定一个Deferred(延迟)对象是否已被拒绝。Deferred Object | Deprecated > Deprecated 1.7 | Removeddeferred.isResolved()确定一个Deferred(延迟)对象是否已被解决。Deferred Objectdeferred.notify()根据给定的 args参数 调用Deferred(延迟)对象上进行中的回调 (progressCallbacks)。Deferred Objectdeferred.notifyWith()根据给定的上下文(context)和args递延调用Deferred(延迟)对象上进行中的回调(progressCallbacks )。Deferred Object | Deprecated > Deprecated 1.8deferred.pipe()用用于过滤 and/or 链式延迟对象的工具方法。Deferred Objectdeferred.progress()当Deferred(延迟)对象生成进度通知时,调用添加处理程序。Deferred Objectdeferred.promise()返回Deferred(延迟)的Promise(承诺)对象。Deferred Objectdeferred.reject()拒绝Deferred(延迟)对象,并根据给定的args参数调用任何失败回调函数(failCallbacks)。Deferred Objectdeferred.rejectWith()拒绝Deferred(延迟)对象,并根据给定的 context和args参数调用任何失败回调函数(failCallbacks)。Deferred Objectdeferred.resolve()解决Deferred(延迟)对象,并根据给定的args参数调用任何完成回调函数(doneCallbacks)。Deferred Objectdeferred.resolveWith()解决Deferred(延迟)对象,并根据给定的 context和args参数调用任何完成回调函数(doneCallbacks)。Deferred Objectdeferred.state()确定一个Deferred(延迟)对象的当前状态。Deferred Objectdeferred.then()当Deferred(延迟)对象解决,拒绝或仍在进行中时,调用添加处理程序。Effects > Custom.delay()设置一个延时来推迟执行队列中后续的项。Events > Event Handler Attachment | Deprecated > Deprecated 3.0.delegate()为所有匹配选择器(selector参数)的元素绑定一个或多个事件处理函数,基于一个指定的根元素的子集,匹配的元素包括那些目前已经匹配到的元素,也包括那些今后可能匹配到的元素。Effects > Custom | Data | Utilities.dequeue()执行匹配元素队列的下一个函数。Selectors > HierarchyDescendant Selector ("ancestor descendant")选择给定的祖先元素的所有后代元素。Manipulation > DOM Removal.detach()从DOM中去掉所有匹配的元素。Events > Event Handler Attachment | Deprecated > Deprecated 1.7 | Removed.die()从元素中删除先前用.live()绑定的所有事件。Selectors > Form:disabled Selector选择所有被禁用的元素。Miscellaneous > Collection Manipulation | Traversing.each()遍历一个jQuery对象,为每个匹配元素执行一个函数。Selectors > BasicElement Selector ("element")根据给定(html)标记名称选择所有的元素。Selectors > Content Filter:empty Selector选择所有没有子元素的元素(包括文本节点)。Manipulation > DOM Removal.empty()从DOM中移除集合中匹配元素的所有子节点。Selectors > Form:enabled Selector选择所有可用的(注:未被禁用的元素)元素。Traversing > Miscellaneous Traversing.end()终止在当前链的最新过滤操作,并返回匹配的元素的以前状态。Selectors > Basic Filter | Selectors > jQuery Extensions | Deprecated > Deprecated 3.4:eq() Selector在匹配的集合中选择索引值为index的元素。Traversing > Filtering.eq()减少匹配元素的集合为指定的索引的哪一个元素。Events > Browser Events | Deprecated > Deprecated 1.8 | Removed.error()Bind an event handler to the "error" event, or trigger that event on an element.Events > Browser Eventserror event为 JavaScript 的 "error" 事件绑定一个处理函数。Selectors > Basic Filter | Selectors > jQuery Extensions | Deprecated > Deprecated 3.4:even Selector选择所引值为偶数的元素,从 0 开始计数。 也可以查看 odd.Traversing > Filtering.even()Reduce the set of matched elements to the even ones in the set, numbered from zero.Events > Event Objectevent.currentTarget在事件冒泡过程中的当前DOM元素。Events > Event Objectevent.data当当前正在执行的处理程序绑定时,一个可选的数据对象传递给一个事件方法。Events > Event Object | Eventsevent.delegateTarget绑定了当前正在调用jQuery 事件处理器的元素。Events > Event Objectevent.isDefaultPrevented()根据事件对象中是否调用过 event.preventDefault() 方法,来返回一个布尔值。Events > Event Objectevent.isImmediatePropagationStopped()根据事件对象中是否调用过 event.stopImmediatePropagation()方法,来返回一个布尔值。Events > Event Objectevent.isPropagationStopped()根据事件对象中是否调用过 event.stopPropagation() 方法,来返回一个布尔值。Events > Event Objectevent.metaKey表示事件触发时哪个Meta键被按下。Events > Event Objectevent.namespace当事件被触发时此属性包含指定的命名空间。Events > Event Objectevent.pageX鼠标相对于文档的左边缘的位置(左边)。Events > Event Objectevent.pageY鼠标相对于文档的顶部边缘的位置(坐标)。Events > Event Objectevent.preventDefault()如果调用这个方法,默认事件行为将不再触发。Events > Event Objectevent.relatedTarget在事件中涉及的其它任何DOM元素。Events > Event Objectevent.result事件被触发的一个事件处理程序的最后返回值,除非值是 undefined。Events > Event Objectevent.stopImmediatePropagation()阻止剩余的事件处理函数执行并且防止事件冒泡到DOM树上。Events > Event Objectevent.stopPropagation()防止事件冒泡到DOM树上,也就是不触发的任何前辈元素上的事件处理函数。Events > Event Objectevent.target触发事件的DOM元素。Events > Event Objectevent.timeStamp这个属性返回事件触发时距离1970年1月1日的毫秒数。Events > Event Objectevent.type描述事件的性质。Events > Event Objectevent.which针对键盘和鼠标事件,这个属性能确定你到底按的是哪个键。Effects > Fading.fadeIn()通过淡入的方式显示匹配元素。Effects > Fading.fadeOut()通过淡出的方式隐藏匹配元素。Effects > Fading.fadeTo()调整匹配元素的透明度。Effects | Effects > Fading.fadeToggle()通过匹配的元素的不透明度动画,来显示或隐藏它们。Selectors > Form | Selectors > jQuery Extensions:file Selector选择所有类型为文件(file)的元素。Traversing > Filtering.filter()筛选元素集合中匹配表达式 或 通过传递函数测试的 那些元素集合。Traversing > Tree Traversal.find()通过一个选择器,jQuery对象,或元素过滤,得到当前匹配的元素集合中每个元素的后代。Effects > Custom.finish()停止当前正在运行的动画,删除所有排队的动画,并完成匹配元素所有的动画。Selectors > Child Filter:first-child Selector选择所有父级元素下的第一个子元素。Selectors > Child Filter:first-of-type Selector选择所有相同的元素名称的第一个兄弟元素。Selectors > Basic Filter | Selectors > jQuery Extensions | Deprecated > Deprecated 3.4:first Selector选择第一个匹配的元素。Traversing > Filtering.first()获取匹配元素集合中第一个元素。Selectors > Basic Filter | Selectors > Form:focus Selector选择当前获取焦点的元素。Events > Form Events | Forms | Deprecated > Deprecated 3.3.focus()Bind an event handler to the "focus" event, or trigger that event on an element.Events > Form Events | Formsfocus event为 JavaScript 的 "focus" 事件绑定一个处理函数,或者触发元素上的 "focus" 事件。Events > Form Events | Forms | Deprecated > Deprecated 3.3.focusin()Bind an event handler to the "focusin" event, or trigger that event on an element.Events > Form Events | Formsfocusin event将一个事件函数绑定到"focusin" 事件。Events > Form Events | Forms | Deprecated > Deprecated 3.3.focusout()Bind an event handler to the "focusout" event, or trigger that event on an element.Events > Form Events | Formsfocusout event将一个事件函数绑定到"focusout" 事件。Miscellaneous > DOM Element Methods.get()通过jQuery对象获取一个对应的DOM元素。Selectors > Basic Filter | Selectors > jQuery Extensions | Deprecated > Deprecated 3.4:gt() Selector选择匹配集合中所有大于给定index(索引值)的元素。Selectors > AttributeHas Attribute Selector [name]选择所有具有指定属性的元素,该属性可以是任何值。Selectors > Content Filter | Selectors > jQuery Extensions:has() Selector选择元素其中至少包含指定选择器匹配的一个种元素。Traversing > Filtering.has()筛选匹配元素集合中的那些有相匹配的选择器或DOM元素的后代元素。Attributes | Manipulation > Class Attribute | CSS.hasClass()确定任何一个匹配元素是否有被分配给定的(样式)类。Selectors > Basic Filter | Selectors > jQuery Extensions:header Selector选择所有标题元素,像h1, h2, h3 等.CSS | Dimensions | Manipulation > Style Properties.height()获取匹配元素集合中的第一个元素的当前计算高度值。设置每一个匹配元素的高度值。Selectors > jQuery Extensions | Selectors > Visibility Filter:hidden Selector选择所有隐藏的元素。Effects > Basics.hide()隐藏匹配的元素。Events > Mouse Events | Deprecated > Deprecated 3.3.hover()将二个事件函数绑定到匹配元素上,分别当鼠标指针进入和离开元素时被执行。将一个单独事件函数绑定到匹配元素上,分别当鼠标指针进入和离开元素时被执行。Attributes | Manipulation > DOM Insertion, Inside.html()获取集合中第一个匹配元素的HTML内容 设置每一个匹配元素的html内容。Selectors > BasicID Selector ("#id")选择一个具有给定id属性的单个元素。Selectors > Form | Selectors > jQuery Extensions:image Selector选择所有图像类型的元素。Miscellaneous > DOM Element Methods.index()从匹配的元素中搜索给定元素的索引值,从0开始计数。CSS | Dimensions | Manipulation > Style Properties.innerHeight()为匹配的元素集合中获取第一个元素的当前计算高度值,包括padding,但是不包括border。CSS | Dimensions | Manipulation > Style Properties.innerWidth()为匹配的元素集合中获取第一个元素的当前计算宽度值,包括padding,但是不包括border。Selectors > Form | Selectors > jQuery Extensions:input Selector选择所有 input, textarea, select 和 button 元素.Manipulation > DOM Insertion, Outside.insertAfter()在目标元素后面插入集合中每个匹配的元素(注:插入的元素作为目标元素的兄弟元素)。Manipulation > DOM Insertion, Outside.insertBefore()在目标元素前面插入集合中每个匹配的元素(注:插入的元素作为目标元素的兄弟元素)。Traversing > Filtering.is()判断当前匹配的元素集合中的元素,是否为一个选择器,DOM元素,或者jQuery对象,如果这些元素至少一个匹配给定的参数,那么返回true。Callbacks ObjectjQuery.Callbacks()一个多用途的回调列表对象,提供了强大的的方式来管理回调函数列表。Deferred ObjectjQuery.Deferred()一个构造函数,返回一个链式实用对象方法来注册多个回调,回调队列, 调用回调队列,并转达任何同步或异步函数的成功或失败状态。Ajax > Low-Level InterfacejQuery.ajax()执行一个异步的HTTP(Ajax)的请求。Ajax > Low-Level InterfacejQuery.ajaxPrefilter()在每个请求之前被发送和$.ajax()处理它们前处理,设置自定义Ajax选项或修改现有选项。Ajax > Low-Level InterfacejQuery.ajaxSetup()为以后要用到的Ajax请求设置默认的值Ajax > Low-Level InterfacejQuery.ajaxTransport()创建一个对象,用于处理Ajax数据的实际传输。Utilities | Deprecated > Deprecated 1.3 | RemovedjQuery.boxModel在jQuery 1.3中不建议使用(查看jQuery.support)。当前页面中浏览器是否使用标准盒模型渲染页面。 建议使用 jQuery.support.boxModel 代替。W3C CSS Box Model。Properties > Properties of the Global jQuery Object | Utilities | Deprecated > Deprecated 1.3 | RemovedjQuery.browser用来获取useragent的包含标志,读取自 navigator.userAgent。这个属性在jQuery 1.9已经被删除并且只能通过的jQuery.migrate插件使用。请尝试使用特征检测代替。 用户的浏览器渲染引擎的版本号。UtilitiesjQuery.contains()检查一个DOM元素是另一个DOM元素的后代。CSSjQuery.cssHooks直接向 jQuery 中添加钩子,用于覆盖设置或获取特定 CSS 属性时的方法,目的是为了标准化 CSS 属性名或创建自定义属性。CSS | Manipulation > Style PropertiesjQuery.cssNumberAn object containing all CSS properties that may be used without a unit. The .css() method uses this object to see if it may append px to unitless values.Data | UtilitiesjQuery.data()存储任意数据到指定的元素,返回设置的值。返回用jQuery.data(element, name, value)储存在元素上的相应名字的数据,或者元素上完整的数据存储Data | UtilitiesjQuery.dequeue()在匹配的元素上执行队列中的下一个函数。UtilitiesjQuery.each()一个通用的迭代函数,它可以用来无缝迭代对象和数组。数组和类似数组的对象通过一个长度属性(如一个函数的参数对象)来迭代数字索引,从0到length - 1。其他对象通过其属性名进行迭代。InternalsjQuery.error()接受一个字符串,并抛出包含这个字符串的异常。CSSjQuery.escapeSelector()Escapes any character that has a special meaning in a CSS selector.UtilitiesjQuery.extend()将两个或

相关推荐: